/*
 * Copyright (c) 2007 Christopher Martin
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMouse Gestures' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.jmg.swing;

import java.awt.Point;
import com.jmg.space.JMGLocation;


/**
 * PointLocation class.
 *
 * @author  Christopher Martin
 * @version $Id: PointLocation.java 13 2007-05-24 12:13:13Z GentlemanHal $
 */
public class PointLocation extends JMGLocation {
    /** Serial Version UID */
    private static final long serialVersionUID = 1L;
    
    
    
    

    /** 
     * Creates a new instance of <code>PointLocation</code> with the default
     * location of (0, 0, 0). 
     */
    public PointLocation() {
        super();
    }
    
    /**
     * Creates a new instance of <code>PointLocation</code>.
     *
     * @param x The x coordinate.
     * @param y The y coordinate.
     * @param z The z coordinate.
     */
    public PointLocation(float x, float y, float z) {
        super(x, y, z);
    }
    
    /**
     * Creates a new instance of <code>PointLocation</code>.
     * 
     * @param point The point which contains the coordinates to set, z will
     *        be set to 0.
     */
    public PointLocation(Point point) {
        this((int) point.getX(), (int) point.getY(), 0f);
    }
    
    
    
    
    
    /**
     * Updates this location with the values from the given <code>Point</code>.
     * 
     * @param  point The point which contains the coordinates to set, z will be
     *         set to 0.
     * @throws java.lang.IllegalArgumentException If a <code>null</code>
     *         argument is passed.
     */
    public void update(Point point) 
        throws IllegalArgumentException
    {
        if (null == point) {
            throw new IllegalArgumentException("point was null!");
        }
        
        
        x = (int) point.getX();
        y = (int) point.getY();
    }
    
}
